Create STOP Payment
Creates a new STOP Payment as a Standing Order using the CreateStandingOrder method for an account to prevent ACH_IN_DEBIT transactions. Set channel to STOP_PAYMENTS and transactionType to ACH_IN_DEBIT.
Method: POST
{{URL}}/jsonrpc
Headers
Name | Value |
---|---|
Content-Type | application/json |
Example
Payload Parameters
Parameter | Description |
---|---|
validUntilDate | String (MM/DD/YYYY) Expiry date for the STOP payment instruction. |
channel | String Must be set to "STOP_PAYMENTS" to indicate a STOP instruction. |
transactionType | String Type of transaction to stop (e.g., "ACH_IN_DEBIT"). |
maxPerTransactionAmount | Integer Maximum allowed transaction amount before STOP is triggered. |
originatorName | String Name of the transaction initiator. |
isOneTimeUse | Boolean Whether this STOP payment is a single-use action. |
accountId | String Account ID where the STOP Payment is being applied. |
Body
{
"method": "SmartContractService.CreateStandingOrder",
"id": "1",
"params": {
"payload": {
"validUntilDate": "5/12/2025",
"channel": "STOP_PAYMENTS",
"transactionType": "ACH_IN_DEBIT",
"maxPerTransactionAmount": 100,
"originatorName": "AJ,lee",
"isOneTimeUse": true,
"accountId": "4032002"
},
"api": {
"credential": "{{cred}}",
"signature": "{{signature}}",
"apiKey": "{{ApiKey}}",
"keyId": "{{DeviceID}}"
}
}
}
Response: 200
Payload Parameters
Parameter | Description |
---|---|
id | String A unique identifier for the request |
result | Object Contains the result of the operation |
result.ID | String A unique identifier for the newly created standing order |
result.message | String A message indicating the status of the operation (e.g., "Standing Order Created Successfully") |
jsonrpc | String The version of the JSON-RPC protocol (e.g., "2.0") |
{
"id": "1",
"result": {
"ID": "TK10000000000009003",
"message": "Standing Order Created Successfully"
},
"jsonrpc": "2.0"
}